home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / path100.zip / BBSINFO.DOC next >
Text File  |  1992-07-03  |  12KB  |  241 lines
  1. This document is effective 7/1/92
  2. BBSINFO.DOC
  3.  
  4.  
  5.                  BBS Onliner Interface  version 1.30
  6.                Copyright (C) 1990,1992 Andrew J. Mead
  7.                          All Rights Reserved.
  8.  
  9.                   Contact:
  10.                        Andrew J. Mead
  11.                        POB 1155
  12.                        Chapel Hill, NC 27514-1155.
  13.                                    or
  14.        1@9952 WWIVnet   1002:735/417 HomeBoyNet   1@9395 VirtualNet
  15.        1:3641/417 FidoNet   75:7919/417 DoorNet   30:507/4 USPolNet
  16.  
  17.                    Sections (in order of appearance)
  18.  
  19.      General info                -  technical specifications
  20.      - sysop abort                  -  F-9, F-10 overrides
  21.      Command line directives     -  customization
  22.      - get player info              -  BBS data
  23.      - locked baud rate             -  lock baud rate /B
  24.      - force local mode             -  local override /L
  25.      - comm port override           -  lock comm port /C
  26.      - IRQ override                 -  customized IRQ/port address /I
  27.      - play Again mode              -  allow multiple games /A
  28.      - local quiet mode             -  turn the bell off locally /Q
  29.      - hall of fame limiting        -  limit appearances in HOF /X
  30.      - text HOF rerouting           -  change HOF path/filenames /Y
  31.      - maximum time limit           -  set time limit /Z
  32.      Tech Talk                   -  how to get help
  33.      - upgrade history              -  changes from version to version
  34.      Support and Distribution    -  Where to find the latest test drives
  35.      Special Thanks              -  people who aren't getting paid for this
  36.  
  37.  
  38.  
  39.                           -  General Info  -
  40.  
  41.    This is an interim release.  The BOI 2.00 is nearing completion.
  42.    I do not need any other beta sites, however, I am looking for a good
  43.    technical writer.
  44.  
  45.    This interface is easily installed.  The documentation, however,
  46.    needs help.  The installation of any game using this interface should
  47.    be almost identical to that of any other game also using this interface.
  48.    The /B switch is heavily recommended, I probably should have made it the
  49.    default. If you have a locked baud rate, you will definitely need it.
  50.    The /L, /C, and /I switches should not be used unless absolutely
  51.    necessary.  This interface currently works directly with 2 A.M., DoorWay,
  52.    Force, Forum, GAP, GT, ModuleX, PCBoard 14.x, Opus-CBSC 1.14, Phoenix,
  53.    RyBBS, SearchLight, Spitfire, Telegard, WildCat, WWIV, and all the
  54.    various DorInfo.Def BBSs (EIS-PC, FoReM, OLEcom, Quick BBS, RBBS 16,
  55.    Remote Access (RA), TAG, and TP-Board).  PCBoard 12.x and Opus-CBCS 1.13
  56.    are currently in the Beta stage.
  57.  
  58.    See BBSNotes.Doc for extra installation help.
  59.  
  60.    - sysop abort
  61.      The SysOp can end the game in progress by pressing either the F-9
  62.      or F-10 function keys.
  63.    - sysop abort - F-10 override
  64.      The game will be aborted, the user will be notified as such, then
  65.      control will revert to the batch file or BBS.
  66.    - sysop abort - F-9 override
  67.      This abort will hang up the phone.  To the user, it will appear as
  68.      if line noise had severed the connection.  The program will then
  69.      terminate, and return control to the batch file or BBS.
  70.  
  71.  
  72.                    -  BBS Command Line Directives  -
  73.  
  74.    - command line directives - BBS information
  75.      There is a command line directive to get player info from the BBS.
  76.      The information that the program uses is username, time remaining,
  77.      lines per screen, communications port, and whether the program is
  78.      being run locally or from remote.
  79.  
  80.      2 A.M. BBS     /2                 Auntie BBS     /7
  81.      DoorWay        /D                 EIS-PC         /R#
  82.      Force BBS      /S                 FoReM          /R#
  83.      Forum          /F                 GAP            /S
  84.      GT             /D                 ModuleX        /M
  85.      OLEcom         /R#                OPUS 1.14      /OXX
  86.      PCBoard 14.x   /P                 Phoenix        /H
  87.      Quick BBS      /R#                RBBS           /R#
  88.      Remote Access  /R#                RyBBS          /5
  89.      SearchLight    /9 (see note)      Spitfire BBS   /6
  90.      TAG            /R#                Telegard       /W
  91.      TP-Board       /R#                UBBS           /R#
  92.      WildCat!       /W                 WWIV           /4
  93.  
  94.      Note for /R# :
  95.        '#' represents the node number.  If it is missing the filename the
  96.        game uses is 'DoorInfo.Def'.  If it is present, the file name
  97.        is 'DorInfo#.Def' where # is the node number. (i.e. DorInfo1.Def)
  98.  
  99.      Note for /9 (SearchLight) :
  100.        See BBSNotes.Doc for more complete information.  This pathname
  101.        after this directive is the reverse of the other switches listed
  102.        here.  The path should be the path to the directory that the game
  103.        itself is in.
  104.  
  105.      If this command is missing, game will default to LOCAL mode.
  106.      The above list is not exhaustive.  The BOI will run directly under many
  107.        other BBSs.  Many BBSs now create the DORINFO#.DEF file, one of the two
  108.        DOOR.SYS file, or the CHAIN.TXT.  If you are running BBS software not
  109.        listed above, please contact me, and let me know if it uses one of the
  110.        above switches.  If it does not, please send a copy of the drop file
  111.        your BBS creates, and indicate (if possible) what lines the user's name,
  112.        screen size (lines), time remaining (minutes or seconds), and what com
  113.        port is in use are on.  A printout or NetMail to one of the addresses
  114.        below would be great.  If your BBS only creates a binary file (like
  115.        PCBoard), I'll need more specific information.  I am also very
  116.        interested in BBSs that send direct parameters (like SearchLight),
  117.        any documentation on direct command line parameters would be welcome.
  118.  
  119.      - alternate file path
  120.      If, for example, your copy of WildCat creates CallInfo.BBS in a sub-
  121.      directory "C:\WC\", and you want to run the game from somewhere else,
  122.      just use the format /?:fullpath, i.e. /W:C:\WC\.  Add a colon and
  123.      the filepath to the directive, and it will work.
  124.  
  125.  * - command line directives - locked baud rate - /B
  126.      If you lock the DTE-DCE (computer-modem) rate above the actual
  127.      connect rate, you will NEED to add this switch to the command line.
  128.      This tells the BOI to use CTS/RTS handshaking.
  129.      This switch is heartily recommended.
  130.  
  131.    - command line directives - force local mode - /L
  132.      You can force the program to use Local mode.  This is designed to
  133.      work with the command above, so that you can play the game locally
  134.      from the BBS.  This will not work with either /C or /I.
  135.  
  136.    - command line directives - communications port override - /C:n
  137.      You can force the program to use a specified serial port.  Use '1' for
  138.      'Com1:', etc...  Example /C:3.  Acceptable values are from 1 to 4.
  139.      This should not be used if one of the above is used.  This will
  140.      not work if either /L or /I is used.
  141.  
  142.    - command line directives - interrupt override - /I:x:nnnn
  143.      You can tailor the game to your specific set up.  This command
  144.      allows you to access any serial port setting.  If you are using
  145.      a non-standard setup, or a PS/2 using Com3 or above, you will
  146.      need to use this.  The default settings, would be equivalent to
  147.      Com1 : /i:4:03f8, Com2 : /i:3:02f8, Com3 : /i:4:03e8, Com4 :
  148.      /i:3:02e8.
  149.      The 'x' is the IRQ number.  It is a hexidecimal value from
  150.      0 to f.  'nnnn' is the port address for communications.  It
  151.      is a 4 digit hexidecimal value.  This will not work if either /L
  152.      or /C is also specified.
  153.  
  154.    - command line directives - play Again? mode - /A:x
  155.      /A:x (/A = /A:10) will prompt the player if he wants to play again
  156.      if he has more than x minutes of game time left.
  157.  
  158.  * - command line directives - quiet local mode - /Q
  159.      /Q will keep the bell from ringing on the host.
  160.  
  161.    - command line directives - limited Hall of Fame listings - /X:n
  162.      You can limit the time any one name appears in the monthly top 20
  163.      with this switch.  The default is unlimited appearances.  The
  164.      recommended limit is 1 or 2.  This keeps a small number of players
  165.      from monopolizing the game.  If an occassional (non-fanatical) is
  166.      more likely to see his name listed, he is more likely to play the game.
  167.      n is any number from 1 to 19.
  168.  
  169.    - command line directives - alternate text Hall of Fame - /Y
  170.      You can change where the program creates its text Hall of Fame, and
  171.      what it is called.  All you have to do is use the following format:
  172.      /Y:pathname\filename where the filename is optional.  This will
  173.      Wildcats, for instance, to use /y:c:\wildcat\bull4.bbs where the text
  174.      file is renamed bull4.bbs and placed in the c:\wildcat directory.
  175.  
  176.    - command line directives - set time limit - /Z:x
  177.      /Z:x (x is a number between 10 and 50), sets a maximum time allowed.
  178.      If a BBS file is read then the maximum time will be the smaller of
  179.      this directive and the user's actual remaining time.
  180.  
  181.  
  182.                    -  That's Not My Table  -  Tech Talk  -
  183.  
  184.      The SysOp accepts all responsibility for this programs implementation.
  185.      The Author is not responsible for any damages caused by running these
  186.      programs.  If you are attempting an installation, it is always best
  187.      to TEST the program before opening it up to the public.  Make sure all
  188.      switches are correct.  If you have any technical questions or any
  189.      suggestions, please send a SASE to the above address or contact me
  190.      through E-Mail on the WWIVnet or the FidoNet.
  191.      If you find another system that this runs on/under that is not
  192.      mentioned above, please include that in your regisration.  I am
  193.      always looking for new systems.
  194.  
  195.  
  196.      Changes from BOI 1.20 to BOI 1.25
  197.         F-9 abort in local mode no longer accesses com port.
  198.         ANSI routine bugs fixed.
  199.         Hall of Fames improved.
  200.         Local mode now uses direct screen writes.
  201.         Various minor command line bugs fixed.
  202.  
  203.      Changes from BOI 1.25 to BOI 1.30
  204.         DESQview routines installed.   Windows routines installed.
  205.         Timeslice sharing installed.   F7/F8 user time change added.
  206.         Registration Key support implemented.
  207.         File sharing / locking capability added.
  208.  
  209.  
  210.                     -  International Support Board  -
  211.  
  212.    This is where you can find the latest testdrive versions of my and
  213.    other programmers programs that feature this interface.
  214.  
  215.    BBS Name              Phone         PCPursuit
  216.    Private Idaho BBS     919-489-9446  NCRPT
  217.  
  218.  
  219.  
  220.                           -  Special Thanks  -
  221.  
  222.    Beta Test Sites - the BBS Onliner Interface
  223.  
  224.    Another World BBS (WWIV) - Durham, NC - (919)220-6299 - WWIVnet 9968
  225.      Dennis O'Dell and Mollie Moses - SysOps and Bowlers extrodinaire
  226.  
  227.     Thanks also to David Malin, Tom Yates, Rick Guggemos, Brian Cox,
  228.     Jack Holsomback, Shirley Gurley, Richard Lee, Kent Ogle, John Reid,
  229.     and a host of others for their time and ideas in helping me make this
  230.     a fully functional interface.
  231.  
  232.                          BBS Onliner Interface
  233.      Copyright (C) 1990, 1992 Andrew J. Mead - All Rights Reserved.
  234.               The Mad Programmer - Brown & Mead Consulting
  235.                   POB 1155 Chapel Hill, NC 27514-1155
  236.  
  237.       This interface is currently written in Turbo Pascal 5.5 and
  238.       can be liscensed by other programmers.  Contact me for
  239.       details.
  240.  
  241. END BBSINFO.DOC